Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update internal links to use relative paths #958

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

hash1go
Copy link
Contributor

@hash1go hash1go commented Oct 6, 2024

Description

  • Update internal links to use relative paths

Tests

Additional context

Metadata

@hash1go hash1go requested a review from a team as a code owner October 6, 2024 06:19
Copy link
Contributor

coderabbitai bot commented Oct 6, 2024

Walkthrough

The document "Running an OP Mainnet Node from Source" has been updated to reflect significant changes in the SSD capacity requirements for running OP Mainnet nodes as of October 2024. Full nodes now require approximately 1.6TB of storage, with an increase of about 1TB every six months, while archive nodes require approximately 5TB, maintaining an increase of 3TB every six months. Additionally, links within the document have been updated for accuracy, particularly regarding Geth's "freezer" feature and configuration details. The tutorial's overall structure remains intact.

Changes

File Path Change Summary
pages/builders/node-operators/tutorials/mainnet.mdx Updated SSD capacity requirements for full and archive nodes; corrected links in the document.

Possibly related PRs

Suggested reviewers

  • sbvegan
  • bradleycamacho

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 38d49bf and a149e8b.

📒 Files selected for processing (1)
  • pages/builders/node-operators/tutorials/mainnet.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pages/builders/node-operators/tutorials/mainnet.mdx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Oct 6, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit a149e8b
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/6703afdbf6db9a000891293f
😎 Deploy Preview https://deploy-preview-958--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
pages/builders/node-operators/tutorials/mainnet.mdx (3)

39-39: LGTM: Updated documentation links

The addition of links to both Geth and OP documentation provides valuable resources for users. The use of a relative link for the OP documentation is correct.

Consider using title case for the link text to adhere to the coding guidelines:

-See [Geth docs](https://geth.ethereum.org/docs/fundamentals/databases) and [OP docs](../configuration/execution-config#datadirancient) for details.
+See [Geth Docs](https://geth.ethereum.org/docs/fundamentals/databases) and [OP Docs](../configuration/execution-config#datadirancient) for details.

Line range hint 201-251: LGTM: Added Snap Sync verification details

The new subsection on Snap Sync verification is a valuable addition to the tutorial. It provides detailed information about the synchronization process and expected log outputs, which will be helpful for users.

Consider adding a brief explanation of what Snap Sync is and why it's the default option for better context:

#### Snap Sync (Default)

+Snap Sync is a faster synchronization method that downloads the latest state directly. It's the default option because it significantly reduces the time required to sync a new node.

Initial synchronization can take several hours to complete. You will see these 
`op-node` logs at the start of snap sync:

Line range hint 253-320: LGTM: Updated Archive Nodes setup instructions

The updates to the Archive Nodes section provide more detailed and up-to-date information for setting up archive nodes. The use of relative links and step-by-step instructions enhances the usability of the tutorial.

Consider adding a note about the time required for extracting large database snapshots:

  {<h3>Extract the Data Directory</h3>}

  Once you've downloaded the database snapshot, you'll need to extract it to a directory on your machine.
-  This will take some time to complete.
+  This process can take several hours to complete, depending on your system's performance.

  ```bash
  tar xvf <filename>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Files that changed from the base of the PR and between 0be241dfa5ae0f0abad5ecdbf191668179e91d7a and 38d49bf7b8bc2d1f3f6a2b00be9862430ded0912.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* pages/builders/node-operators/tutorials/mainnet.mdx (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (1)</summary><blockquote>

<details>
<summary>pages/builders/node-operators/tutorials/mainnet.mdx (1)</summary>

Pattern `**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Use **bold** for prominence instead of all caps or italics.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
"


</details>

</blockquote></details>

</details>

<details>
<summary>🔇 Additional comments (2)</summary><blockquote>

<details>
<summary>pages/builders/node-operators/tutorials/mainnet.mdx (2)</summary><blockquote>

`31-34`: **LGTM: Updated storage requirements**

The storage requirements for full and archive nodes have been accurately updated with the latest information as of October 2024. The use of bold for emphasis and the clear presentation of data adhere to the coding guidelines.

---

Line range hint `43-46`: **LGTM: Added Blob Archiver assessment section**

The new section on assessing the need for a blob archiver service is a valuable addition to the tutorial. It provides important information for node operators and uses a relative link to the documentation, adhering to the coding guidelines.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@hash1go hash1go changed the title Update SSD requirements and add config links Update internal links to use relative paths Oct 7, 2024
@krofax krofax merged commit 6150418 into ethereum-optimism:main Oct 7, 2024
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants